home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / rcf2102b.zip / READ.ME < prev    next >
Text File  |  1997-06-10  |  11KB  |  264 lines
  1.  
  2.                      REXX Code Formatter/2 - READ.ME
  3.                      ---------------------------------
  4.  
  5. Welcome to REXX Code Formatter/2.
  6.  
  7. This file contains information you need to install REXX Code Formatter/2,
  8. and additional information not included in the product documentation.
  9.  
  10. This READ.ME file is divided into the following chapters:
  11.    -  REXX Code Formatter/2 Description 
  12.    -  REXX Code Formatter/2 Registration
  13.    -  Before You Install REXX Code Formatter/2
  14.        -Software Requirements
  15.        -Hardware Requirements
  16.    -  Installing REXX Code Formatter/2
  17.    -  Removing REXX Code Formatter/2
  18.    -  Getting Help
  19.    -  Trademarks
  20.    -  Release History
  21.  
  22.  
  23. REXX Code Formatter/2 Description
  24. -----------------------------------
  25. The REXX Code Formatter/2 (RCF/2) is an OS/2(*) REXX application written 
  26. using VisPro/REXX(**) and VisPro/Reports(**).  It is designed to allow a
  27. REXX programmer to format a program in a particular style, insuring that
  28. the format of each element of the REXX program conforms to that style.
  29.  
  30. NOTES: (1) This program makes use of the RexxUtils functions that comes 
  31.            with OS/2, and it assumes they have not been removed.
  32.        (2) You do not need to have VisPro/REXX or VisPro/Reports 
  33.            installed on your system to run RCF/2.
  34.  
  35.  
  36. Features of REXX Code Formatter/2
  37. ---------------------------------
  38.  
  39. Using this product, users may, for example:
  40.  
  41.    Define the indentation to be used in general plus the amount for: 
  42.     - Program statements subordinate to DO and SELECT,
  43.     - Statements that begin with THEN/ELSE, and 
  44.     - Continued statements.
  45.    Specify whether:
  46.     - Lines are to be split at semicolons,
  47.     - Redundant spaces are to be removed from program statements,
  48.     - New lines are to start before or after THEN/ELSE keywords, and
  49.     - END statements are to be indented to align with the corresponding 
  50.       DO/SELECT subordinate statements.
  51.    Specify the formatting for:
  52.     - REXX keyword Instructions,
  53.     - REXX keywords besides those that begin a REXX keyword instruction,
  54.     - Variables names,
  55.     - Function names, and
  56.     - Labels.
  57.    Define special formatting for selected function names.
  58.    Check for duplicate labels and insure all labels start on a new line.
  59.    Have RCF/2 create a file of label names as they appear in the program
  60.     so that all references to them in the program (and even other
  61.     programs) will reflect this same format.
  62.    Align full-line, left-hand, and right-hand comments.
  63.    Add "commented line number" to program statements.
  64.    Generate a listing of the formatted program.
  65.  
  66. In addition, while RCF/2 is not a syntax-checker or code debugger, it 
  67. does provide some assistance in program development.  It can, for
  68. example:
  69.  
  70.    Identify DO and SELECT instructions missing a corresponding END clause,
  71.    Create cross-reference information for labels, variables, and function 
  72.     names,
  73.    Flag function names that might be misspelled,
  74.    Flag comments that are not started but not closed, and
  75.    Highlight literal strings with a missing quote.
  76.   
  77.  
  78. REXX Code Formatter/2 Registration
  79. ------------------------------------
  80.    This program is SHAREWARE.  The registration fee is $15 U.S. per copy.
  81.  
  82.    To register your copy of REXX Code Formatter/2 and receive your
  83.    Registration Key, order RCF/2 from RKE Consulting, Inc., or BMT Micro.
  84.  
  85.    For BMT Micro orders, see the BMTORDER.TXT file which is contained in
  86.    this package, or refer to the "Registration" section found in the
  87.    RCF/2 on-line help facility.
  88.  
  89.    To order from RKE Consulting, Inc., send $15 per copy (Texas 
  90.    residents, please send $16.09 per copy) drawn on a U.S. bank to:                                 
  91.                                                           
  92.          RKE Consulting, Inc.                           
  93.          P.O. Box 11569                                 
  94.          Spring, TX 77391-1569                          
  95.                                                         
  96.     Please indicate whether you would like your Registration Key sent by
  97.     normal mail (i.e., snail-mail) or E-mail, and include the address to
  98.     be used.                                               
  99.  
  100.  
  101. Before You Install REXX Code Formatter/2
  102. ------------------------------------------
  103.    Software Requirements
  104.    ---------------------
  105.     IBM Operating System/2(*) (OS/2) Warp 3.x. or higher
  106.  
  107.    Hardware Requirements
  108.    ---------------------
  109.     -  A personal computer that runs OS/2 Warp 3.0 or higher
  110.                                                                        
  111.     -  1MB of fixed disk space above that required by OS/2 
  112.  
  113.  
  114. Installing REXX Code Formatter/2
  115. ----------------------------------
  116.  
  117.     If you have received In RCF/2 on a diskette, skip to step 2.
  118.  
  119.     STEP 1: If you have down-loaded or received RCF/2 as a ZIP file,
  120.     you will need to use the PKZIP(r) software by Pkware, Inc. To
  121.     perform this step, do the following:
  122.  
  123.         A. Obtain a copy PKUNZIP.EXE to unpack the file.  This
  124.            program is readily available on most BBS's and FTP's 
  125.            sites.
  126.  
  127.         B. Make the directory containing the RCF2.ZIP file the
  128.            default directory.  At the OS/2 command prompt, enter the
  129.            command:
  130.  
  131.                    PKUNZIP RCF2nnnn.ZIP
  132.  
  133.            Where "nnnn" is a suffix.  (This suffix is associated with
  134.            the release of RCF/2.  The higher suffix being the later
  135.            release of the program.)
  136.  
  137.     STEP 2: If installing from diskette, place the distribution 
  138.     diskette in your diskette drive.
  139.  
  140.     STEP 3: At the OS/2 prompt, enter one of the following:
  141.  
  142.         A. If installing from diskette on drive A, enter:
  143.  
  144.                    A:\INSTALL
  145.  
  146.         B. If installing from diskette on drive B, enter:
  147.  
  148.                    B:\INSTALL
  149.   
  150.         C. If installing from a fixed disk (for example, the
  151.            directory where RCF2nnnn.ZIP has been "unzipped"), 
  152.            enter the full path to the INSTALL.EXE program.
  153.  
  154.            To illustrate, if the RCF/2 package has been placed
  155.            in the "TEMP" directory on the "C:" drive, enter:
  156.  
  157.                    C:\TEMP\INSTALL
  158.  
  159.     STEP 4: Answer the installation program questions.
  160.  
  161.     STEP 5: When complete, an RCF/2 program icon will appear
  162.     on your desktop.  (You may move it to any convenient place.)
  163.     Double-clicking the program icon will start RCF/2.
  164.  
  165.     See the RCF/2 help introduction for more information about
  166.     getting started with RCF/2.
  167.  
  168.  
  169. Removing REXX Code Formatter/2
  170. --------------------------------
  171.     To remove the installation of RCF/2, do the following:
  172.  
  173.     STEP 1: Run the RCF/2 installation procedure and select:
  174.  
  175.         Delete the installed product and re-install
  176.  
  177.     STEP 2: After the deletion is complete, exit the install
  178.     procedure without doing the re-install.
  179.  
  180. Getting Help
  181. ------------
  182.  
  183.    Documentation
  184.  
  185.    -   Documentation is provided through the RCF/2 Help facility.
  186.  
  187.        Please review the on-line help "Introduction" for valuable
  188.        information about support, limitations, and future enhancements.
  189.  
  190.    Service and Technical Support
  191.  
  192.    -   Technical support is free to all registered users of RCF/2.
  193.        Questions and problems should be sent via E-mail Inc. to
  194.        rkeinc@ibm.net, or faxed to RKE Consulting, Inc. at
  195.        281-370-9842.  Please write in English, and include a return
  196.        address where we may respond.
  197.  
  198.    Defect Reporting
  199.  
  200.    -   If you believe that you have found a defect in RCF/2, please 
  201.        report it to the Technical Support using the procedure described
  202.        in the on-line help for "Support" which is a sub-chapter of the 
  203.        "Introduction."
  204.  
  205.  
  206. Trademarks
  207. ----------
  208.    (*)   IBM and OS/2 are trademarks of the International Business 
  209.          Machines Corporation.
  210.  
  211.    (**)  VisPro/REXX and VisPro/Reports are trademarks of HockWare, Inc.
  212.  
  213.  
  214. Release History
  215. ---------------
  216.  
  217. Release 1.1.0  Initial release.
  218.  
  219. Release 1.1.1  A maintenance modification release to correct various 
  220.                bugs and problems found in the initial RCF/2 release, 
  221.                primarily caused by the differences between Warp 3 and 4.
  222.                This release includes:
  223.                - Fixes to eliminate loading problems when running under 
  224.                  OS/2 Warp 3 with classical REXX and Warp 4 with Object 
  225.                  REXX. 
  226.                - Correction to incorrect program listing output.
  227.                - Corrections to miscellaneous help panels.
  228.                - Modifications to some notebook pages to accommodate 
  229.                  differences between Warp 3 and Warp 4.
  230.                - Elimination of a bug that could cause two settings 
  231.                  notebooks to be open at the same time.
  232.  
  233. Release 1.1.2  Corrected an error that could prevent an editor from being
  234.                properly configured and invoked.
  235.  
  236. Release 1.2.0  New product release.  This release adds:
  237.                - A cross reference facility for labels, variables, and
  238.                  function names.
  239.                - Optional formatting notes if undefined function names are 
  240.                  found. 
  241.                - The ability to add "Commented line numbers" to statements.
  242.                - Landscape printing formats.
  243.                - Right-hand alignment of full-line comments with extension 
  244.                  and truncation to allow for "boxing" of comments.
  245.                - Specification of file name and directory for generated
  246.                  associated label files.
  247.                - Maintenance of multiple generated associated label 
  248.                  file data in a single file.
  249.                - Separate formatting specification for the standard REXX
  250.                  built-in functions.
  251.                - The specification of the file to be edited as a parameter 
  252.                  at RCF invocation.
  253.                - The extension of the allowable indentation values to be up 
  254.                  to 999.
  255.                - Placement of the print specification in a separate page to
  256.                  facilitate changing of printer specifications.
  257.                - Use of Warp 4 notebook format for configuration settings 
  258.                  when using OS/2 Warp 4.
  259.  
  260. Release 1.2.1  A maintenance release to correct the following:
  261.                - Missing function names in the internal function names 
  262.                  tables.
  263.                - Corrected print menu selection options.
  264.